<html>
<head><meta charset="utf-8"><title>Documentation guidelines · general · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/index.html">general</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Documentation.20guidelines.html">Documentation guidelines</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="243394402"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Documentation%20guidelines/near/243394402" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Jonas Schievink  [he/him] <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Documentation.20guidelines.html#243394402">(Jun 21 2021 at 14:55)</a>:</h4>
<p>I recall seeing some official API documentation guidelines, but can't seem to find them. Do they exist?</p>



<a name="243394471"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Documentation%20guidelines/near/243394471" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Jonas Schievink  [he/him] <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Documentation.20guidelines.html#243394471">(Jun 21 2021 at 14:55)</a>:</h4>
<p>I don't think I mean <a href="https://rust-lang.github.io/api-guidelines/documentation.html">https://rust-lang.github.io/api-guidelines/documentation.html</a>, I saw something else</p>



<a name="243398116"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Documentation%20guidelines/near/243398116" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Eric Huss <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Documentation.20guidelines.html#243398116">(Jun 21 2021 at 15:18)</a>:</h4>
<p><a href="https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html">RFC 1574</a> is the only other thing I can think of.</p>



<a name="243399653"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Documentation%20guidelines/near/243399653" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Jonas Schievink  [he/him] <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Documentation.20guidelines.html#243399653">(Jun 21 2021 at 15:29)</a>:</h4>
<p>I think that might be it, thanks!</p>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>